/***********************************************************************
	filename: 	CEGUIEventArgs.h
	created:	21/2/2004
	author:		Paul D Turner
	
	purpose:	Defines base EventArgs class used with event signalling
*************************************************************************/
#ifndef _hgeGuiEventArgs_h_
#define _hgeGuiEventArgs_h_

/*!
\brief
	Base class used as the argument to all subscribers Event object.

	The base EventArgs class does not contain any useful information, it is intended
	to be specialised for each type of event that can be generated by objects within
	the system.  The use of this base class allows all event subscribers to have the
	same function signature.

	The \a handled field is used to signal whether an event was actually handled or not.  While
	the event system does not look at this value, code at a higher level can use it to determine
	how far to propagate an event.
*/
class EventArgs
{
public:
	/*************************************************************************
		Construction
	*************************************************************************/
	EventArgs(void) : handled(0) {}
	virtual ~EventArgs(void) {}

	/*************************************************************************
		Data members
	*************************************************************************/
    //! handlers should increment this if they handled the event.
    unsigned int handled;
};

#endif	// end of guard _hgeGuiEventArgs_h_
